/*
 *  SPAGL Copyright (C) 2008 Sam Pottinger
 *  This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser 
 *  General Public License as published by the Free Software Foundation; either version 2.1 of the License, or 
 *  (at your option) any later version. This library is distributed in the hope that it will be useful, but 
 *  WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 
 *  See the GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License along with this library; if not, 
 *  write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 
 */

package spagcore;

/**
 * An interface to standardize the use of Radio Buttons
 * @author Sam Pottinger
 * @see SpaglCoreRadioGroup
 */
public interface SpaglCoreRadioButton extends SpaglCoreWidget, SpaglFontCapable, SpaglImageCapable, SpaglCoreEventGenerator {
	
	/**
	 * Sets the text that will be displayed on the face of this widget
	 * @param newText The string that will be assigned to this object
	 */
	public void setText(String newText);
	
	/**
	 * Gets the text associated with this object
	 * @return The string being displayed on the face of this widget
	 */
	public String getText();
	
	/**
	 * Sets the selection status of this widget where true is selected and false is not
	 * @param newValue True will result in a "checked" status and false will result in an "empty" status
	 */
	public void setSelected(boolean newValue);
	
	/**
	 * Returns the selection status of this widget
	 * @return If this widget is selected true will be returned otherwise it returns false
	 */
	public boolean isSelected();

}
